Skip to content

Add API column to role capabilities tables #5481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 16 commits into from
Oct 15, 2025
Merged

Add API column to role capabilities tables #5481

merged 16 commits into from
Oct 15, 2025

Conversation

@kimsauce
Copy link
Collaborator

@kimsauce kimsauce commented Jun 17, 2025 •
edited
Loading

Purpose of this pull request

Adds a new third column to every capabilities table in role-capabilities.md containing the exact backend API schema API identifiers (e.g., viewCollectors, manageUsersAndRoles).

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

#5476
https://sumologic.atlassian.net/browse/DOCS-380

@kimsauce kimsauce linked an issue Jun 17, 2025 that may be closed by this pull request
API documentation not matching documentation on some items #5476
Closed
@cla-bot cla-bot bot added the cla-signed Contributor approved, listed in .clabot file label Jun 17, 2025
@kimsauce kimsauce self-assigned this Jun 17, 2025
@kimsauce kimsauce marked this pull request as draft June 17, 2025 03:40
@jpipkin1 jpipkin1 assigned jpipkin1 and unassigned kimsauce Oct 1, 2025
@jpipkin1 jpipkin1 added the doc:update Revisions and updates to content label Oct 15, 2025
@jpipkin1 jpipkin1 marked this pull request as ready for review October 15, 2025 18:33
@jpipkin1
Copy link
Collaborator

jpipkin1 commented Oct 15, 2025

@kimsauce, could you review this PR?

kimsauce
kimsauce commented Oct 15, 2025
View reviewed changes
kimsauce
kimsauce commented Oct 15, 2025
View reviewed changes
kimsauce
kimsauce commented Oct 15, 2025
View reviewed changes
kimsauce
kimsauce commented Oct 15, 2025
View reviewed changes
kimsauce
kimsauce commented Oct 15, 2025
View reviewed changes
kimsauce
kimsauce commented Oct 15, 2025
View reviewed changes
kimsauce
kimsauce commented Oct 15, 2025
View reviewed changes
Copy link
Collaborator Author

@kimsauce kimsauce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just about everything here matches the API, but I think some of the ones here might only be in the UI and not the API guide.

@jpipkin1
Copy link
Collaborator

jpipkin1 commented Oct 15, 2025

Thanks for your review, @kimsauce! You wrote:

Just about everything here matches the API, but I think some of the ones here might only be in the UI and not the API guide.

The API doc is not up-to-date, and Development needs to add the role capabilities they list here.

@kimsauce
Copy link
Collaborator Author

kimsauce commented Oct 15, 2025

Thanks for your review, @kimsauce! You wrote:

Just about everything here matches the API, but I think some of the ones here might only be in the UI and not the API guide.

The API doc is not up-to-date, and Development needs to add the role capabilities they list here.

Thank you for clarifying and for taking this on. I realized it was originally my PR, so it won't let me approve, but I approve :D

@jpipkin1 jpipkin1 added this pull request to the merge queue Oct 15, 2025
Merged via the queue into main with commit 2468c7c Oct 15, 2025
7 checks passed
@jpipkin1 jpipkin1 deleted the 5476-api-documentation-not-matching-documentation-on-some-items branch October 15, 2025 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jpipkin1 jpipkin1 jpipkin1 approved these changes

@JV0812 JV0812 Awaiting requested review from JV0812 JV0812 is a code owner

@mafsumo mafsumo Awaiting requested review from mafsumo mafsumo is a code owner

@amee-sumo amee-sumo Awaiting requested review from amee-sumo amee-sumo is a code owner

Assignees

@jpipkin1 jpipkin1

Labels

cla-signed Contributor approved, listed in .clabot file doc:update Revisions and updates to content

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

API documentation not matching documentation on some items

3 participants

@kimsauce @jpipkin1